extensionSystem: Save extension errors per-extension

Extension developers may be confused about why their extensions aren't working:
the LookingGlass isn't a very obvious place, or even which errors are theirs.
To remedy this, save all errors per-UUID which allows them to be retrieved
later.

https://bugzilla.gnome.org/show_bug.cgi?id=654770

diff --git a/js/ui/extensionSystem.js b/js/ui/extensionSystem.js
index 0d7b199c78965777a1a5f10fd9390dbe7f229e02..813290287553183c8d46ce11d2536d6676279270 100644 (file)
--- a/js/ui/extensionSystem.js
+++ b/js/ui/extensionSystem.js
@@ -41,6 +41,9 @@ Signals.addSignalMethods(_signals);
 const connect = Lang.bind(_signals, _signals.connect);
 const disconnect = Lang.bind(_signals, _signals.disconnect);
 
+// UUID => Array of error messages
+var errors = {};
+
 /**
  * versionCheck:
  * @required: an array of versions we're compatible with
@@ -71,13 +74,19 @@ function versionCheck(required, current) {
     return false;
 }
 
+function logExtensionError(uuid, message) {
+    if (!errors[uuid]) errors[uuid] = [];
+    errors[uuid].push(message);
+    global.logError('Extension "%s" had error: %s'.format(uuid, message));
+}
+
 function loadExtension(dir, enabled, type) {
     let info;
-    let baseErrorString = 'While loading extension from "' + dir.get_parse_name() + '": ';
+    let uuid = dir.get_basename();
 
     let metadataFile = dir.get_child('metadata.json');
     if (!metadataFile.query_exists(null)) {
-        global.logError(baseErrorString + 'Missing metadata.json');
+        logExtensionError(uuid, 'Missing metadata.json');
         return;
     }
 
@@ -85,44 +94,44 @@ function loadExtension(dir, enabled, type) {
     try {
         metadataContents = Shell.get_file_contents_utf8_sync(metadataFile.get_path());
     } catch (e) {
-        global.logError(baseErrorString + 'Failed to load metadata.json: ' + e);
+        logExtensionError(uuid, 'Failed to load metadata.json: ' + e);
         return;
     }
     let meta;
     try {
         meta = JSON.parse(metadataContents);
     } catch (e) {
-        global.logError(baseErrorString + 'Failed to parse metadata.json: ' + e);
+        logExtensionError(uuid, 'Failed to parse metadata.json: ' + e);
         return;
     }
+
     let requiredProperties = ['uuid', 'name', 'description', 'shell-version'];
     for (let i = 0; i < requiredProperties.length; i++) {
         let prop = requiredProperties[i];
         if (!meta[prop]) {
-            global.logError(baseErrorString + 'missing "' + prop + '" property in metadata.json');
+            logExtensionError(uuid, 'missing "' + prop + '" property in metadata.json');
             return;
         }
     }
 
-    if (extensions[meta.uuid] != undefined) {
-        global.logError(baseErrorString + "extension already loaded");
+    if (extensions[uuid] != undefined) {
+        logExtensionError(uuid, "extension already loaded");
         return;
     }
 
     // Encourage people to add this
     if (!meta['url']) {
-        global.log(baseErrorString + 'Warning: Missing "url" property in metadata.json');
+        global.log('Warning: Missing "url" property in metadata.json');
     }
 
-    let base = dir.get_basename();
-    if (base != meta.uuid) {
-        global.logError(baseErrorString + 'uuid "' + meta.uuid + '" from metadata.json does not match directory name "' + base + '"');
+    if (uuid != meta.uuid) {
+        logExtensionError(uuid, 'uuid "' + meta.uuid + '" from metadata.json does not match directory name "' + uuid + '"');
         return;
     }
 
     if (!versionCheck(meta['shell-version'], Config.PACKAGE_VERSION) ||
         (meta['js-version'] && !versionCheck(meta['js-version'], Config.GJS_VERSION))) {
-        global.logError(baseErrorString + 'extension is not compatible with current GNOME Shell and/or GJS version');
+        logExtensionError(uuid, 'extension is not compatible with current GNOME Shell and/or GJS version');
         return;
     }
 
@@ -139,7 +148,7 @@ function loadExtension(dir, enabled, type) {
 
     let extensionJs = dir.get_child('extension.js');
     if (!extensionJs.query_exists(null)) {
-        global.logError(baseErrorString + 'Missing extension.js');
+        logExtensionError(uuid, 'Missing extension.js');
         return;
     }
     let stylesheetPath = null;
@@ -150,7 +159,7 @@ function loadExtension(dir, enabled, type) {
         try {
             theme.load_stylesheet(stylesheetFile.get_path());
         } catch (e) {
-            global.logError(baseErrorString + 'Stylesheet parse error: ' + e);
+            logExtensionError(uuid, 'Stylesheet parse error: ' + e);
             return;
         }
     }
@@ -162,11 +171,11 @@ function loadExtension(dir, enabled, type) {
     } catch (e) {
         if (stylesheetPath != null)
             theme.unload_stylesheet(stylesheetPath);
-        global.logError(baseErrorString + e);
+        logExtensionError(uuid, e);
         return;
     }
     if (!extensionModule.main) {
-        global.logError(baseErrorString + 'missing \'main\' function');
+        logExtensionError(uuid, 'missing \'main\' function');
         return;
     }
     try {
@@ -174,7 +183,7 @@ function loadExtension(dir, enabled, type) {
     } catch (e) {
         if (stylesheetPath != null)
             theme.unload_stylesheet(stylesheetPath);
-        global.logError(baseErrorString + 'Failed to evaluate main function:' + e);
+        logExtensionError(uuid, 'Failed to evaluate init function:' + e);
         return;
     }
     extensionMeta[meta.uuid].state = ExtensionState.ENABLED;

diff --git a/js/ui/shellDBus.js b/js/ui/shellDBus.js
index f423ca18ee044e0fa88800c5f714834f4d4e862b..78cd8a04f9ef2c132bc2df7662a5725438d58b24 100644 (file)
--- a/js/ui/shellDBus.js
+++ b/js/ui/shellDBus.js
@@ -20,6 +20,10 @@ const GnomeShellIface = {
                 inSignature: 's',
                 outSignature: 'a{sv}'
               },
+              { name: 'GetExtensionErrors',
+                inSignature: 's',
+                outSignature: 'as'
+              }
              ],
     signals: [],
     properties: [{ name: 'OverviewActive',
@@ -80,6 +84,10 @@ GnomeShell.prototype = {
         return ExtensionSystem.extensionMeta[uuid] || {};
     },
 
+    GetExtensionErrors: function(uuid) {
+        return ExtensionSystem.errors[uuid] || [];
+    },
+
     get OverviewActive() {
         return Main.overview.visible;
     },